Address Auto-Complete
Provides real-time suggestions for address inputs, enhancing user experience by predicting and completing addresses as they are typed.
Endpoint URL
https://api.propertyreach.com/v1/suggestions
Query Params
query
string
required
The address, city, zip, county, or street to search for.
Response Body
suggestions[]
type
string
required
Suggestion type (address, city, state, county, zip)
title
string
Descriptive label for result; e.g. full address, city name, etc
streetAddress
string
What's the property street address
city
string
The city where the property is located.
state
string
State search criteria
zip
string
Property zip code
county
string
The county where the property is located.
propertyId
int
PropertyReach Property ID
businessId
bigint
PropertyReach Business ID
meta
status
decimal
required
Response status
message
string
required
Response message.
requestId
string
Unique ID for the request.
resultCount
int
Number of results found
hits
decimal
Number of credits deducted from your API usage balance for this call
- Source
var options = {
method: 'GET',
headers: {
'x-api-key': 'test_examp****'
}
};
var url = 'https://api.propertyreach.com/v1/suggestions';
fetch(url, options)
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.log('error', error));